field: Document return value of fe_sqrt() #1347
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
@stratospher Interested in reviewing this small PR? |
real-or-random
force-pushed
the
202306-fe-sqrt-ret-docs
branch
from
c66c30c to
cc1ad2f
Compare
Contributor
|
ACK cc1ad2f. |
jonasnick
reviewed
Jun 16, 2023
src/field.h
Outdated
Comment on lines
270
to
271
| * Performs {r = sqrt(a)} and returns 1 if sqrt(a) exists. | ||
| * Performs {r = sqrt(-a)} and returns 0 otherwise; then sqrt(-a) exists. |
Contributor
There was a problem hiding this comment.
nit: maybe case distinction like this is clearer?
* If sqrt(a) exists, performs {r = sqrt(a)} and returns 1.
* Otherwise, sqrt(-a) exists. The function performs {r = sqrt(-a)} and returns 0.
Co-authored-by: Jonas Nick <jonasd.nick@gmail.com>
real-or-random
force-pushed
the
202306-fe-sqrt-ret-docs
branch
from
cc1ad2f to
5779137
Compare
Contributor
|
ACK 5779137 |
theStack
approved these changes
Jun 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.